fix: remove extraneous source.description schema property; clarify entity.description covers MCP#3552
Merged
Merged
Conversation
…cription to mention MCP Agent-Logs-Url: https://github.com/Azure/data-api-builder/sessions/2aa78b8c-2875-4f50-a041-233f820d3d83 Co-authored-by: Aniruddh25 <3513779+Aniruddh25@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix extraneous source.description property in JSON schema
fix: remove extraneous May 13, 2026
source.description schema property; clarify entity.description covers MCP
Aniruddh25
requested review from
Alekhya-Polavarapu,
JerryNixon,
RubenCerna2079,
aaronburtle,
anushakolan,
rusamant,
sourabh1007,
souvikghosh04,
stuartpa and
vadeveka
as code owners
Aniruddh25
approved these changes
May 18, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Cleans up the DAB JSON schema by removing a dead entities.*.source.description property (never bound to EntitySource) and updating entities.*.description to mention that it surfaces in MCP tool discovery — guiding users to the field that actually drives MCP output.
Changes:
- Removed unused
source.descriptionproperty from the entity source schema. - Expanded the
entity.descriptiondocumentation to include MCP tool discovery.
Collaborator
|
/azp run |
|
Azure Pipelines successfully started running 6 pipeline(s). |
anushakolan
approved these changes
May 18, 2026
souvikghosh04
approved these changes
May 19, 2026
Aniruddh25
reviewed
May 19, 2026
Agent-Logs-Url: https://github.com/Azure/data-api-builder/sessions/9db0c1d2-d559-45b5-8bbd-763045e8e6a5 Co-authored-by: Aniruddh25 <3513779+Aniruddh25@users.noreply.github.com>
Aniruddh25
approved these changes
May 19, 2026
anushakolan
approved these changes
May 19, 2026
github-project-automation
Bot
moved this from Review In Progress
to Done
in Data API builder
aaronburtle
added a commit
that referenced
this pull request
May 20, 2026
…rty (#3552) (#3612) Cherry-pick of #3552 from `main` to `release/2.0`. **Original PR:** fix: remove extraneous `source.description` schema property; clarify `entity.description` covers MCP (#3552) **Cherry-picked commit:** f3d159d Co-authored-by: Copilot <198982749+Copilot@users.noreply.github.com> Co-authored-by: Souvik Ghosh <souvikofficial04@gmail.com> Co-authored-by: aaronburtle <93220300+aaronburtle@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why make this change?
entities.*.source.descriptionexisted in the JSON schema with documentation claiming it drove MCP tool discovery — but it was never wired to any C# model (EntitySourcehas noDescriptionfield) and was silently ignored at runtime. Meanwhile,entities.*.description— the field that actually surfaces in MCP — made no mention of MCP. Users following the schema would configure the wrong field and get no MCP output with no error.What is this change?
entities.*.source.descriptionfromschemas/dab.draft.schema.json. The property never had a backing field inEntitySourceand was dead schema surface area.descriptionproperty (which was the last property in the source object'spropertiesblock).entities.*.descriptionto explicitly mention MCP:The correct config pattern for MCP-visible descriptions is:
How was this tested?
Schema-only change; no runtime behavior altered. The removed property had no backing model field and was never deserialized. JSON validity confirmed via
python3 -m json.tool.Sample Request(s)
N/A — schema documentation fix only.